Skip to content

doc: add File modes cross-references in fs methods #60286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: add File modes cross-references in fs methods #60286

wants to merge 1 commit into from

Conversation

@Mohit-Raj-Saxena
Copy link

@Mohit-Raj-Saxena Mohit-Raj-Saxena commented Oct 16, 2025

Adds cross-references to the File modes section from methods that use the mode parameter, improving discoverability of file permission documentation.

Changes

  • Added [File modes][] links in fsPromises.open(), fsPromises.mkdir(), and fs.mkdir() parameter documentation
  • Added [File modes]: #file-modes link reference

Motivation

Previously, developers using methods with mode parameters (like 0o666, 0o777) had to manually search for the File modes table. This change provides direct links to the relevant documentation.

Fixes #60280

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Oct 16, 2025
@Mohit-Raj-Saxena Mohit-Raj-Saxena mentioned this pull request Oct 16, 2025
Open
@Mohit-Raj-Saxena
Copy link
Author

Mohit-Raj-Saxena commented Oct 23, 2025

Friendly ping @nodejs/documentation 👋

Would appreciate any feedback on this when you have a chance! Happy to make any changes if needed.

Thanks for your time!

@Mohit-Raj-Saxena
Copy link
Author

Mohit-Raj-Saxena commented Nov 7, 2025

Bumping this after 3 weeks - would really appreciate any feedback! 🙂

@Mohit-Raj-Saxena
A
5cd21cf 
doc: add File modes cross-references in fs methods

Adds links to the File modes section from fsPromises.open(),
fsPromises.mkdir(), and fs.mkdir() to improve discoverability
of file permission documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Multiple Documentation Issues in fs and fs/promises Modules (Formatting, Consistency, and Clarity)

2 participants

@Mohit-Raj-Saxena @nodejs-github-bot